Skip to content

2.4: source metadata, the assistant guide, and packages from npm - #37

Merged
spellfull merged 16 commits into
mainfrom
release/2.4
Nov 13, 2026
Merged

spellfull merged 16 commits into
mainfrom
release/2.4

Conversation

@spellfull

Copy link
Copy Markdown
Contributor

Documents release 2.4: describing a source and importing its metadata (a new how-to, the recipe catalogue, connector pages, reference and troubleshooting), contracts only where a person must say what the source cannot, working with a coding assistant, the VS Code extension 2.3.0, and Upgrade to 2.4. The pages now build from the published packages (definitions 1.14.0, core 1.2.0, authoring and cli 2.4.0, the packs, standards 1.1.0).

The Architect added 16 commits November 13, 2026 03:12
Signed-off-by: The Architect <hello@ingestron.io>
…nd recipe pointers

Signed-off-by: The Architect <hello@ingestron.io>
…recipe pointer fewer

Signed-off-by: The Architect <hello@ingestron.io>
…SAP ECC recipe pointer

Signed-off-by: The Architect <hello@ingestron.io>
A new guide under Build a project walks from the source request through each way of describing a source (the recipe's query, a published document, a sample, the columns file and an assistant's columns file), the import and what changed, to drafting the contracts a table needs. Its commands, outputs and files are checked against a project made by init.

The pages that said every flow table needs a contract now say when one is needed: definitions, how Ingestron works, the first project, adding a source, contracts, quality, access, layers, the home page and each connector page.

Signed-off-by: The Architect <hello@ingestron.io>
…drafts and severity; troubleshooting for source metadata

A table that copies a source can do without a contract unless the platform manages its access, on the overview, the template guide and every connector page. The guide keeps only names and types, adds the rule for a nested record seen in one record, the access: { contract: false } exception, what status: draft and a decimal's precision mean in a draft, the fail and warn settings, the plan's first notice, and what a VS Code import records and asks. Troubleshooting gains entries for TABLE_NO_COLUMNS, CONTRACT_NEEDED and the SOURCE_ codes.

Signed-off-by: The Architect <hello@ingestron.io>
A page for the project guide: what init --assistant, assistant add and
the New project picker write for each assistant, how plan and apply keep
the section current, the source metadata part and the columns file, and
where to keep the project.

The VS Code page gains the two source commands, import on save with one
notice per batch, completion from the source metadata with its quoting,
the table hover, the drafting fix, the metadata document's notice, the
recipe problems only the editor shows, and Add assistant files. The
command list is synced with the extension (2.3.0).

Also: the pins move to ingestron@2.4.0, Upgrade to 2.4, the home page's
guide section, the troubleshooting causes of CONTRACT_NEEDED, and links to
when a table needs a contract.

Signed-off-by: The Architect <hello@ingestron.io>
Signed-off-by: The Architect <hello@ingestron.io>
…e new-file picture

Signed-off-by: The Architect <hello@ingestron.io>
…page's title; fix round

contract --from-metadata does not read recipes, in the VS Code page and
the exit codes. Upgrade to 2.4 no longer names a data product's output as
a reason for CONTRACT_NEEDED. The assistant page's description names no
assistant, and it lists plan's edited-by-hand line and the missing
project.yaml line. The three older VS Code pictures say what they leave
out.

Signed-off-by: The Architect <hello@ingestron.io>
…g changes an import reports exit 0

Signed-off-by: The Architect <hello@ingestron.io>
…t once

Signed-off-by: The Architect <hello@ingestron.io>
Signed-off-by: The Architect <hello@ingestron.io>
…the source metadata actions, and import once the save settles

Signed-off-by: The Architect <hello@ingestron.io>
… (plan 4)

Signed-off-by: The Architect <hello@ingestron.io>
Signed-off-by: The Architect <hello@ingestron.io>
@spellfull
spellfull merged commit 09434a1 into main Nov 13, 2026
1 check passed
@spellfull
spellfull deleted the release/2.4 branch November 13, 2026 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant